Overview
~~~~~~~~

	The following is a reference to the overall approach to running the CCHRRD conversion system after installation and project configuration has been completed. 
	It assumes that the following `prerequisites`_ have been met. 
	
		.. Note: The below list is a high level approach. It is very important that the user review the more detailed sections of these commands to understand
				 the behavior of each command, the various parameters that can be specified for each command, and the necessary quality control that needs to take place
				 before and after each step.  
	
	1. The first step is to create the standardized and relational databases and to load the NLETS/Pragmatica intermediate files into the standardized database. 
	   This is accomplished with the stage command.   
	
	   >>> python cchrrd.py stage
		
		Please reference the `stage`_ documentation page for more information on the stage command.
		
	2. After the databases have been created and intermediate files are loaded the data is ready to be run through the various phases of business logic. 
	   The first phase applies the pre_process rules and this phase is invoked through the pre_process command.  
	
	   >>> python cchrrd.py pre_process
	   
	   Please reference the `Pre-Process`_ documentation page for more information on the pre_process command.
	   
	3. The next step is to apply the process business rules to the pre-processed data. 
	   After this step is complete the standrardized relational database and SPSS file extracts will be available to the user.
	   
	   The command to run the process phase is:
		
	   >>> python cchrrd.py process
	   
	   Please reference the `Process`_ documentation page for more information on the pre_process command.
	
	4. After the process phase is complete the next step is to transform the standardized relational database into the 
	   recidivism relational database. 
	   
	   This is a two step process that first issueing the transform command:
	
	   >>> python cchrrd.py transform
	   
	   and then running the load_recid_db command:
	   
	   >>> python cchrrd.py load_recid_db
	   
	   After the load_recid_db command has completed the recidivism relational databases and SPSS extract files will be available. 
	   
	   Please reference the `transform`_ documentation page for more information on the transform command.
	   Please reference the `load_recid_db`_ documentation page for more information on the load_recid_db command.
	   
	5. The final step is to create the demographic, criminal history, and summary SPSS flat files. 
	
	   This is accomplished through the load_recid_flat command 
	
	   >>> python cchrrd.py load_recid_flat
	   
	   After this command is finished running the demographic and summary SPSS flat files will be ready. However, due to the size of the 
	   Criminal History Flat file there is an additional step of loading this file from a raw text format into SPSS. 
	   
	   Please reference the `transform`_ documentation page for more information on the load_recid_flat command including how to load the Criminal History Flat file into SPSS.
	

 .. _prerequisites: Go here
 .. _stage: Go here
 .. _pre_process: Go here

History
-------

Insert Project History

Project Mission
---------------

The CCHRRD Conversion Software's mission is to provide an open source expert coding system 
for harmonizing  parsed criminal history records obtained from the NLETS III system. 

To provide maximum flexibility, the Conversion Software is licensed under the `MIT license`_.

 .. _MIT license: http://opensource.org/licenses/MIT

Current Development Status
--------------------------

With the release of version 1.0, the CCHRRD Conversion Software has achieved its first production release.

Version 1.02.a is currently under development at NORC and includes a new predictive modeling component to 
make predictions at offense codes that are not supported by the current business rules.   
